TPUG - Toronto PET Users Group

home *** CD-ROM | disk | FTP | other *** search

/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / (A)TB / (A)TBX.ADF / ClockDJv5.04 / Docs / ClockDJ.doc < prev next >

Wrap

Text File | 1992-03-19 | 47KB | 1,872 lines

ClockDJ - Assembly language clock, mouse, screen and window program. Version - 5.04 Copyright - Copyright (c) by David Jenkins, 29 Jan 1992. I can be reached at Bloom Beacon 416-283-5924, and CRS 416-629-4825/416-629-7070 This program is copyright but may be distributed freely. Please keep the documentation with the load module. Version 5.04 ~~~~~~~~~~~~ 1. New ARexx commands: CYCLE ON|OFF TOPDEFAULT ON|OFF PRIORITY n Sets clock priority REFRESH n Sets refresh rate BLANKSCREEN OFF|n Sets screen blank BLANKPOINTER OFF|n set screen pointer KEYBLANK OFF|ON set key blank MOUSESPEED n set mouse speed CLICKTOFRONT OFF|n set click to front DISCARD OFF|ON set discard CLICKTOBACK OFF|n set click to back SUN OFF|IMMEDIATE|DELAYED set sun mouse KEYACTIVATE OFF|ON set key activate MAPKEYS OFF|ON set map keys SHOWDATE OFF|ON set show date CLOSEWINDOW close clock window OPENWINDOW open clock window GETNAMEOFSCREEN address gets the name of a public screen SETDEFAULTSCREEN name sets this screen up as the default screen GETMOUSEX gets the X position of mouse in RESULT GETMOUSEY gets the Y position of mouse in RESULT See the main documentation for a description of these. 2. The click to front now adheres to the double click times set in preferences. 3. The WindowToFront code for a click-to-front mouse operation is back in the input handler to avoid the annoying wait when bringing a workbench window to front in 2.04. 4. The memory display now handles up to 99 meg. 5. Some cosmetic changes to the menus. 6. Menu items now use topaz 8 whatever the screen font. 7. The window size will adjust to the font size automatically. 8. The "Screen" menu item has sub-items of "Cycle" (same as before) and "Top "Default". "Top Default" makes the top screen - if it is a public screen - the default screen for opening windows that would normally open on the workbench screen. This only works for 2.04. 9. A couple of bugs were fixed. Version 5.03 ~~~~~~~~~~~~ 1. Added "Key Blank" to the "Blank Pointer" menu item. This blanks the pointer when a key is pressed. 2. Added "Immediate" and "Delayed" options to the "Sun Mouse" menu. "Immediate" works as before and "Delayed" activates the window after the mouse has stopped moving. 3. The screen blanker now checks to see if another screen has opened in front of the blank screen, If it has, the screen is re-blanked. 4. Thanks to Enforcer, Memmung and IOTorture a few bugs were fixed: Do ABORTIO in delay routine so timer.device is not reused. Freemem of 40 bytes instaed of 32 bytes on closedown. Discovered by IOTorture. Stick a WaitIO after the ABORTIO on closedown. Injected data did not always appear as it should. Version 5.02 ~~~~~~~~~~~~ 1. A number of bugs in the "Show Date" routime, and pop to front when using overscan are fixed. 2. If the ARexx LOADKEYS is used without a filename it will reload the key file loaded. 3. When using the Cygnus file requester in extended select mode, a single selection would return a bad value. This is fixed. 4. The following ARexx commands have been added: 'SETCEDDIRCOLOUR' set the colour for ced directories. 'SETCEDFILECOLOUR' set the colour for ced files. 'SETCEDDEVCOLOUR' set the colour for ced devices. 'SETCEDLINES' set the number of lines in the requester. 'SETCEDFILECOLS' set the number in the files column. 'SETCEDDEVCOLS' set the number in the device column. SETCEDBOXCOLOUR' set string requester box colour. Version 5.01 ~~~~~~~~~~~~ 1. In this version you can call the Cygnus file requester; for this to work, you must copy req.library to your LIBS: directory. There are a number of ways of calling the Cygnus file requester: in a clock macro or from an ARexx macro using single or extended selections. See the section on the Cygnus file requester for details. The new macro variables are: &ced1 call Cygnus file requester. &cede call extended select Cygnus file requester. &cedd call directory only Cygnus file requester. New ARexx macros for the Cygnus file requester are: 'CEDREQUESTERDIR' get a dir 'CEDEXTENDEDREQUESTER' pop up a ced extended requester 'SETCEDDIR' set ced Dir 'SETCEDFILE' set ced File 'CEDREQUESTER' pop up a ced requester 'SETCEDTITLE' set title 'SETCEDHIDE' set hide files 'SETCEDSHOW' set show files 2. You may define hot keys for flipping screens or windows; see the section on window manipulation for details. New hot key variables for key macros are: &win bring bottom window to the top. &sc1 cycle screens including workbench. &sc2 cycle screens excluding workbench. &wbs bring Workbench screen to the front. 3. If you select the "Show Date" menu item, the date will appear in the clock window once per minute. 4. I have removed the "Snooze" menu item under "Blank Pointer" since the variety of snooze pointer shapes makes this feature impractical. 5. The clockdj.config and clockdj.keys files are now saved to the S: directory. If you want this version to read your existing config and keys files, move them to the S: directory before starting this new version of the clock. Version 5.00 ~~~~~~~~~~~~ Version 5.00 works on release 2.0 of the operating system in addition to earlier releases. The ARexx LOADKEYS routine is fixed. WTFPATCH5 ~~~~~~~~~ The arc file contains 'WTFPATCH5', an improved version of the WindowToFront patch. Include 'WTFPatch5' in your start-up sequence, but make sure you remove the old version of the patch (WTFPatch) first. 'WTFPatch5' corrects an Intuition bug in WindoToFront and WindowToBack. To use it, simply put the 'WTFPatch5' program in your c: directory and include 'WTFPatch5' in your startup sequence. You won't need this fix for release 2.0 of the operating system. NOTE: Kickstart/Workbench 2.xx does not need the patch Program Description ~~~~~~~~~~~~~~~~~~~ This utility combines a clock, mouse accelerator, screen blanker, window manipulator, function keys, macros, and ARexx support. The display is a small borderless window which shows the total memory left in the system (chip and fast) and the time in 12 hour format. The window pops to the front screens once every minute. You can start the program with a 'Run ClockDJ', 'Runback ClockDJ', or by clicking on a Workbench icon. (Do NOT use Workbench 1.3 'run >nil:' or the ARP Arun NOIO commands. Only the RunBack in the zoo file or a RunBack to the NUL: device will work correctly in this situation). Using 'Runback' is useful if you want to close ALL CLI windows. If you start the clock with 'Runback', the output which is directed to the default CLI will not be seen. This is not usually a problem since this output is typically of the '[CLI 3]' variety. If you use 'Runback' or the Workbench to start the program, command macros (those ending with a '\c') MUST specify output and input redirection to nil:. Eg.: \lal\b\run <nil: >nil: blitz\r\c If you do not do this the MACHINE WILL GURU. If you want to start the clock with a 'run' so that the output from macros to the default CLI is preserved, but the startup CLI is to be closed, do something like this: newcli "con:0/0/580/200/AmigaDOS " from df0:command.file endcli > nil: "commands.file" is a file located on df0: containing the following: run clockdj Starting the clock in this way preserves the file handle of the CLI which launched the clock and passes it to programs started by the macros. Start-up parameters (CLI start-up only) ~~~~~~~~~~~~~~~~~~~ "r" specified as the first parameter will reverse the action of the mouse buttons for the features that require both to be depressed. The default is "n", for normal operation. The "Newcli" entry in the menu may now be changed by specifying a second parameter when starting the clock. Eg.: run clockdj n NewWsh con:0/0/640/150/Myname Note that if the second parameter is specified, the first parameter must also be specified. Arp File requester ~~~~~~~~~~~~~~~~~~ The Arp file requester can be called from a macro either alone or as a symbolic variable within the command string. For this to work you must have V 34 of Arp.Library in your libs: directory. To call the requester on its own, include a macro that looks like this: \lal\`\&arfx\r\s\2 where x is either 1 or 2. The numbers change the colour scheme of the requester, This will open the requester on the top screen when you press the Left-alt and ` (top left of the keyboard) together. Obviously you can make the key combination anything you want. When you have selected a file from the requester, the next left mouse button click will cause the selected file (including disk and dir) to be entered into the window where you click. The character delay (2 in the above example) will be observed. There are a couple of ways to modify the string that is generated: Holding down Left Shift when you click will insert a right Amiga x at the start of the characters; this is useful for clearing existing data out of a string gadget. Holding down CTRL will submit the directory for the first mouse click and the file for the second. This is useful for filling in strings where the directory and file are in separate gadgets (in Dpaint, for example). Holding down CTRL+Left Shift when you click will submit the directory and file names separately and precede each with a Right Amiga x. To include the requester as a variable in a command: The macro definitions will allow &arf1 and &arf2 to be defined as symbolic variables anywhere in the string fields of a macro. This will cause the Arp file requester to be called when the macro is invoked; the selected file name (and path) will be substituted for the variable. Any number of &arf1 (or &arf2) variables can be included in the string. The variable can be specified in either command or string macros (command macros have a "c" at the end, string macros have an "s" at the end). For example: \ral\t\type &arf2\r\c When RightAlt + t are pressed, submit a "type filename" command where "filename" is selected from the Arp file requester. \ral\d\delete &arf2\r\c When RightAlt + d are pressed, Submit a "delete filename" command where "filename" is selected from the Arp file requester \ral\c\copy &arf2 &arf1 all\r\c When RightAlt + c are pressed, submit a "copy file1 file2 all" command where file1 and file2 are selected from the Arp file requester. \ral\l\list &arf2\r\s When RightAlt + l are pressed, submit a "list filename" string where filename are selected from the Arp file requester. The Cygnus File Rquester ~~~~~~~~~~~~~~~~~~~~~~~~ The file "req.library" is public domain; once you copy it to your LIBS: directory you can call the Cygnus file requester in much the same way as the ARP file requester above. To call the requester on its own, include a macro that looks like this: \lal\`\&ced1\r\s\2 NOTE: there is no &ced2 yet! This will open the requester on the top screen when you press the Left-alt and ` (top left of the keyboard) together. Obviously you can make the key combination anything you want. When you have selected a file from the requester, the next left mouse button click will cause the selected file (including disk and dir) to be entered into the window where you click. The character delay (2 in the above example) will be observed. There are a couple of ways to modify the string that is generated: Holding down Left Shift when you click will insert a right Amiga x at the start of the characters; this is useful for clearing existing data out of a string gadget. Holding down CTRL will submit the directory for the first mouse click and the file for the second. This is useful for filling in strings where the directory and file are in separate gadgets (in Dpaint, for example). Holding down CTRL+Left Shift when you click will submit the directory and file names separately and precede each with a Right Amiga x. To include the requester as a variable in a command: The macro definitions will allow &ced1 to be defined as symbolic variables anywhere in the string fields of a macro. This will cause the Cygnus file requester to be called when the macro is invoked; the selected file name (and path) will be substituted for the variable. Any number of &ced1 variables can be included in the string. The variable can be specified in either command or string macros (command macros have a "c" at the end, string macros have an "s" at the end). For example: \ral\t\type &ced1\r\c When RightAlt + t are pressed, submit a "type filename" command where "filename" is selected from the Cygnus file requester. \ral\d\delete &ced1\r\c When RightAlt + d are pressed, Submit a "delete filename" command where "filename" is selected from the Cygnus file requester \ral\c\copy &ced1 &ced1 all\r\c When RightAlt + c are pressed, submit a "copy file1 file2 all" command where file1 and file2 are selected from the Cygnus file requester. \ral\l\list &ced1\r\s When RightAlt + l are pressed, submit a "list filename" string where filename are selected from the Cygnus file requester. The Extended Select Cygnus file requester ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The Cygnus file requester will allow multiple files to be selected in one pass. To call a requester capable of extended selection use &cedex (where "x" is the delimeter to be placed between the file names) in the clock macro and hold a shift key while making the selection. Note that &cede can only be used in a command macro (one ending in a \c). Example: \lal\pixelscript &cede \r\c will submit a list of files to PixelScript. The delimeter is a blank. Directory Cynus File Requester ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A Cygnus file requester for selecting a directory may be called by specifying &cedd in the clock macro. Example: \lal\d\&cedd\r\s Will inject the selected directory string when the LeftAlt d keys are pressed and the mouse is clicked. This requester may be called in a string or command macro. Window manipulation ~~~~~~~~~~~~~~~~~~~ The following can be selected from the menu or by clicking the correct combination of mouse buttons: 1. Screen blanking after a pre-defined period of inactivity. 2. Pointer blanking after a pre-defined period of inactivity. 3. Mouse accelerator. 4. Sun mouse. 5. Click the window to front with the left mouse button. 6. Click the window to back by pressing the left mouse button followed by the right mouse button, with the left button still down. 7. Cycling through screens by pressing the right mouse button followed by the left mouse button with the right button still down. 8. Left-Amiga-m will shuffle screens if "Screen Cycle" is selected. 9. A hot-key combination can be defined for cycling screens. In the clockdj.keys file the following variables may be defined: &win - brings the bottom window to the top &sc1 - cycles screens including the Workbench screen &sc2 - cycles screens excluding the Workbench screen &wbs - bring the Workbench screen to the top. Examples: \lal\w\&win\r\s Bring the bottom window to the front when LeftAlt w is pressed. \lal\n\&wbs\r\s Bring the workbench screen to the front when LeftAlt n is pressed \lal\m\&sc1\r\s Cycle screens (including the workbench screen) when LeftAlt m is pressed \lal,lsh\m\&sc2\r\s Cycle screens (excluding the workbench screen) when LeftAltLeftshift m is pressed The button sequences for 6. and 7. can be reversed by specifying the parameter "r" when starting the clock: eg: run clockdj r All the above can be selected my menus and saved in the configuration file. Hide Window ~~~~~~~~~~~ The program will allow the user to select a window and remove it from the screen while leaving the task that started it unaffected. To do this, point at the window you want to remove, hold the LeftShift+LeftAmiga+Control keys down and press the left mouse button; the window should disappear. To bring the window back hold LeftShift+LeftAmiga+Control keys and press the right mouse button. Up to 60 windows can be hidden in this way. When retrieving windows the last one removed is brought back first. A separate list of hidden windows is maintained for each screen, so only the windows for the active screen are retrieved. I put this feature in because my workbench screen is often cluttered with small windows opened by tasks like VirusX. These windows serve no useful purpose and I decided I would like a means of removing them. Restrictions: 1. CLI windows cannot be removed. Doing so confuses things and ends in a guru, so the CLI windows are ignored when selecting a window to hide. 2. Some programs look at their window size; FileInjector does this. If the small FileInjector window is hidden and the hot key sequence is used, the resulting window is smaller than it should be. The solution is one of: don't hide this type of window; retrieve the window before the hot key; retrieve the window after the hot key. The last option would require a window refresh too (move the window). 3. You should use this feature with caution. Some programs don't expect to have other tasks interfere with their windows and gurus can occur. Generally, if the window holds only text then there will not be a problem. Changing the window size of the clock display ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From release 5.04, the vertical size of the clock window changes automatically to fit the font. Moving the clock window to another screen ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The clock window can be popped to the next screen immediately by holding down the left shift key while clicking the left mouse button in the clock window. This feature works whatever is selected in the Pop to Front menu item. Menu options ~~~~~~~~~~~~ NewCLI ------ Gives you a new CLI window at the bottom of the screen. Chip/Fast --------- This option gives chip and fast memory displays separately. When selected the menu toggles to "Total Memory" to enable you to get back to a total memory display. Colour ----- Allows you to select the colour of the clock display. Priority -------- The default priority of the clock is 2 which seems to work OK in most circumstances. Setting it to 0 makes it the same priority as other tasks started from CLI. Making it negative gives it a lower priority than other CLI tasks. This option gives you a choice of running the clock from -3 to +4. I found the negative values useful while running a Basic drawing program: anything above -1 made the drawing process jerky. Refresh ------- This is the maximum rate at which the program will update the display. The default is 5 times per second and the options allow from 10 times to once per second. I only do an PrintIText if something has changed, so even 10 times per second does not use much CPU - you can use pm to see how much. Blank Screen ------------ The screen will blank after the specified time (in minutes) if there is no keyboard or mouse activity. Blank Pointer ------------- The mouse pointer will blank after the specified time (in seconds) if there is no mouse activity. If the "Key Blank" item is checked, the pointer will blank when a key is pressed. Mouse Speed ----------- Accelerates the mouse pointer. 1 is no acceleration. Click to front -------------- Clicking the left mouse button in a window the specified number of times will bring it to the front. Click to front now gives you the option of keeping or discarding the last of the left mouse button clicks which brings the window to front. There is a 'Discard' sub-menu item under 'Click to Front'. If 'Discard' is checked the last mouse click is discarded. The difference this option makes is mainly seen when the last mouse click is on an icon or other field you wish to select. To find out which to use, experiment. Click to back ------------- Click the window to back by pressing the left mouse button followed by the right mouse button the specified number of times. Note that this sequence can be reversed by specifying "r" as a start-up parameter Sun Mouse --------- Activates the window the pointer is above without having to click the left mouse button. The activation can be immediate or delayed. Screen Cycle ------------ Cycling through screens by pressing the right mouse button followed by the left mouse button with the right button still down. Note that this sequence can be reversed by specifying "r" as a start-up parameter The screen cycle can also be triggered by specifying a key macro using &sc1 or &sc2. Selecting "Top Default" in the menu will make the top screen - if it is a public screen - the default screen for opening windows that would normally open on the workbench screen. This requires release 2.04 of the OS. Key Activate ------------ If this feature is used, the window under the pointer will be activated when a key is depressed. Pop to Front ------------ Selecting this item causes the clock to pop to the front of the current screen if 'Windows' is selected, or to the top screen if 'Screens' is selected. The Pop to Front menu item has a sub-item called "Cling". If you select this a message will appear asking you to click in a window. When you do, the clock will attach itself to the selected window; the clock menu will also become a part of this window. Note that only windows with no existing menus or UserPort are eligible to be selected. In practise this confines you to CLI windows. Once the clock is attached to a window, the "Cling" menu item is highlighted; re-selecting "Cling" will move the clock to its own window on the Workbench screen. If you close a window the clock is attached to, it will re-open itself on the Workbench screen. If "Save" is selected when the clock is attached to a window, the window title will be saved in the clockdj.config file. When the clock is started, it will look for a window with this title and attach itself to the window. Map Keys -------- When checked, the key mapping and macro functions are active. Load Keys --------- Loads in a new set of key and macro definitions. Save ---- If you select "Save", all the current settings, including the window position, will be written to a file called "clockdj.config" in the root directory of sys:. You should be careful to ensure that sys: is assigned to the correct disk so that the file can be read when the clock is next started. The next time clockdj starts it will attempt to read this file and set up the clock and associated parameters exactly as they were when you selected "Save". You should select this option when you are happy with the way the clock looks, and then make sure you have the disk with the clockdj program on it assigned to sys:. Quit ---- Ends the program. Macros and redefining the keys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ClockDJ will allow you re-map the keyboard, substitute a string of characters for a single key depression, or execute a command when a particular key sequence is pressed. The key definitions and macros must be created by you and saved in a file; the default file read when the program starts is sys:clockdj.keys. The key definitions can be changed by selecting Load Keys from the menu. Pressing CTRL-` (the "ctrl" key and the "`" key) is an escape for the next key/mouse sequence entered. This will prevent translation or macro generation on the next key/mouse sequence. NB. 'Map Keys' must be selected from the menu to activate the macro function. The statement format is: \xxx,yyy\z\wwwwww\r\s\5 | | | | k c | | | | | | | |_The delay between each character in 10ms | | | | | | | increments. | | | | | | | | | | | |_ s = string; c = command | | | | | | | | | |_ r = replace character with the string or command | | | | k = generate string or command, but keep the | | | | original | | | | character. | | | | | | | |_ String to be generated, or command to be executed. | | | | | |_ Character to be re-mapped. | | | |_ List of qualifiers (see below), separated by commas. | | |_ Delimiter. NOTE: Any line that begins with an asterisk (*) will be treated as a comment. Delimiter --------- A "\" is the character used to delimit fields. If you wish to include one in the string, precede it with a "^". Qualifiers ---------- This defines which keys must be pressed with the re-map character to generate the string or command. eg., you may want the qualifiers to be left shift and right alt. If no qualifiers are needed to trigger the re-map, the statement would start with a "\\". Multiple qualifiers are specified by separating them by commas: eg., "lsh,lat,ctl". The valid qualifiers are: (all in lower case) lsh Left shift. rsh Right shift. clo Caps lock. ctl Control (CTRL). lal Left alt. ral Right alt. lam Left Amiga. ram Right Amiga. The above qualifiers must be specified in lower case. ~~~~ Character to be re-mapped. ------------------------ This field is either a single character - "w", for example - or a string of characters which represents a single character. If a single character is specified it must be in lower case; if you want the upper case character re-mapped you must use two statements with "lsh" and "rsh" qualifiers. This also applies to keys like "{", "!" etc. whose lower and upper case representations are different. Valid strings are: (in lower case) **** NOTE: to include one of these characters in a submitted character string (or to call a file requester), prefix the key string with an "&". Eg. &del &arf1 etc. f01 The function keys. f02 | f03 | f04 | f05 | f06 | f07 | f08 | f09 | f10 V hel Help key. esc Escape key. tab Tab key. bsp Backspace key. ret Return key. del Delete key. upa Up arrow. lea Left arrow. doa Down arrow. ria Right arrow. kp0 Key pad 0. kp1 Key pad 1. kp2 Key pad 2. kp3 Key pad 3. kp4 Key pad 4. kp5 Key pad 5. kp6 Key pad 6. kp7 Key pad 7. kp8 Key pad 8. kp9 Key pad 9. kp. Key pad .. kp- Key pad -. kpe Key pad enter. kp) Key pad ). kp( Key pad (. kp/ Key pad /. kp+ Key pad +. The following can only be used in the submitted strin or command part of the macro: &win bring bottom window to the top. &sc1 cycle screens including workbench. &sc2 cycle screens excluding workbench. &wbs bring Workbench screen to the front. &arf1 Arp file requester. Colour 1. If specified alone, the selection &arf2 Ditto, Colour 2 will be injected into the window at the next Left Mouse Button click. If specified with other characters, will act as a symbolic variable; the selection will replace the variable in the command/string. &ced1 call Cygnus file requester. &cede call extended select Cygnus file requester. &cedd call directory only Cygnus file requester. The above keys must be specified in lower case. ~~~~ String ------ The string of characters which will replace the character to be re-mapped. Special keys (del, bsp, for example) may be inserted into the string. They are specified by preceding the key name with a "&". For example, "&del" would be delete, "&ret" would be return, etc. Any key listed above in the "Character to be re-mapped" section can be specified in this way (still in lower case). Previous versions of the program allowed a limited set of control characters in the string by using the "^". This will still work. The characters which can be defined in this way are: ^[ Escape. ^h Backspace. ^i Tab. ^m Return. The "^" and "\" can be included in the string by preceding them with a "^". A character in a macro string may include a qualifier. Any of the qualifiers listed above under "Qualifiers" are valid. The qualifier is preceded by a "%" and multiple qualifiers are separated by commas. Eg., "%lal,%ctla" (in lower case) would specify LeftAlt+CTRL+a. Multiple qualifiers should be separated by commas. This can be useful for entering data in a string gadget (a file requester, for example). The file name you want in the requester may be "myfile"; specifying "%ramxmyfile" in the string would clear the gadget before filling it with "myfile". The string should appear in the active window. Each statement can be up to 1000 characters long. Replace/Keep ------------ An "r" causes the re-mapped character to be replaced with the string or command. A "k" will keep the re-mapped character. This must be specified in lower case. String/Command -------------- An "s" will submit the string into the input stream: it should appear in the active window. A "c" will execute the string as a command. A "^m" (CR) or "&ret" at the end of the command is not needed. The command will be launched from the clock task AT THE SAME PRIORITY AS THE CLOCK; the default clock priority is 2. Some programs do not run well at priority 2 - eg Txed, Excellence, Blitz - since they use input handlers running at priority 0. To avoid this kind of problem either run the clock at priority 0 or use the ARP Arun command and set the priority of the new task to 0. This must be specified in lower case. Delay ----- **************** * NOTE * **************** Version 4.06 and above contain improvements which, as far as I know, eliminate the need to specify a delay. It is still supported, however. The delay value will delay each character by the value*15 milliseconds. Eg., a value of 5 specifies 75 ms. The delay field can be between 0 and 9. If the delay is omitted, a delay of 0 is assumed. Examples ~~~~~~~~ \\f01\run >nil: <nil: ed\r\c Will run ed . Notice that no qualifier was specified for the function key F1. The redirection to nil: is to prevent unwanted messages in the console window. \ctl,lsh\f01\dir df0:\r\c When CTRL, left shift and F1 are depressed a dir df0: will execute and the result will appear in the window belonging to the cli which started ClockDJ. This would work only if ClockDJ has NOT been started with 'RunBack'. \lal\t\run >nil: <nil: Terminals:gt/gt\r\c Run GT when left-alt t is depressed. \lal\esc\newcli <nil: >nil:\r\c Start a new cli when Left-alt esc is depressed. \lal\n\David Jenkins\r\s\5 Submit the string when left-alt n is depressed and insert a 50 ms delay between each character. \lal\m\Inter-Office Correspondence&ret&retFrom: David Jenkins&ret&retTo:&ret&retSubject:&ret&ret___________________________ __________________________________________________&ret&ret\r\s\5 Submit the string when left-alt m is depressed and insert a 50 ms delay between each character.. \clo\`\~\r\s \clo\1\!\r\s Convert Caps lock "`" and "1" to "~" and "!". \lal\f\%ramxdf0:file1\r\s Is useful for putting a string into a requester. The "%ramx" will submit a Right Amiga-x which will clear the string gadget before submitting the "file1" string. \lal\w\&win\r\s Will bring the bottom window of the screen to the top when LeftAlt w is pressed \lal\n\&wbs\r\s Will bring the Workbench screen to the front when LeftAlt n is pressed. \lal\m\&sc1\r\s Will cycle through screens (incuding the Workbench screen) when LeftAlt m is pressed. \lal,lsh\m\&sc2\r\s Will cycle through screens (excuding the Workbench screen) when LeftAltLeftShift m is pressed. \ral\l\runwsh List &cede \r\c Will bring up the Cygnus file requester, let you extended select a list of files and submit them to "list". \lal\`\&ced1\r\s Will bring up the Cygnus file requester and pump the full file name into the window where you click the left mouse button. AREXX Macros ~~~~~~~~~~~~ ClockDJ versions 4.00 and above contain an ARexx port. The clock is an ARexx host and will accept commands from an ARexx program; the commands are listed below. If a result is expected it will be returned in the special ARexx variable 'result'; any commands which return a result should have a 'options results' statement in the program. Title of ClockDJ ---------------- The clock window has a title of 'ClockDJ' (case sensitive); you can use this title in some of the ARexx macros. For an example of this take a look at Move.Rexx and Move2.Rexx. Host Name --------- The host name of ClockDJ is CLOCKDJ (in capitals). Errors ------ Errors are reported by setting a return code (the RC variable). A return code of 20 is set for an unrecognized command. A return code of 10 is set for an invalid parameter (an invalid window address, for example). Commands -------- NOTE: when executing commands which manipulate windows (like MOVE), be careful not to submit too many requests for the same window without a pause between the requests. Intuition gets upset if it receives a request for a window before it has acted on the previous request; the ARexx function 'delay' (in rexxsupport.library) can be used to accomplish this: eg., 'call delay 5'. ACTIVATEWINDOW address Activate the window with this address. The window may be on any screen. ******************* DELAY value Specify an inter-character delay value in microseconds for injected data. The delay value remains in effect for all injected data; if you want to reset it to zero, submit a 'delay 0' command. ******************* CEDREQUESTER Call the Cygnus file requester. The full pathname of the selected file will be returned in 'result'. If 'cancel' is selected on the Cygnus file requester, a null string will be returned in 'result'. Notes: 1. You must specify OPTIONS RESULTS for this macro to work. 2. If you want a directory to be returned even if no file is selected, set the file nmae to one blank with SETCEDFILE. (eg SETCEDFILE ' '). 3. See POINTCOPY.REXX and DELETECOPY.REXX for examples on how to use the Cygnus file requester commands. ******************* CEDEXTENDEDREQUESTER Call the Cygnus extended select file requester. The files selected are placed in 'result' separated by line feeds ('0a'x). Notes: 1. You must specify OPTIONS RESULTS for this macro to work. ******************* SETCEDDIR dirname will set the initial directory string in the Cygnus file requester to dirname. ******************* SETCEDFILE filename will set the initial file string in the Cygnus file requester to filename. ******************* CEDREQUESTERDIR Call the Cygnus file requester for selecting a directory. The selected directory is returned in 'result'. ******************* SETCEDTITLE set the title of the Cygnus file requester. ******************* SETCEDHIDE sets the hide files wild card string in the Cygnus file requester. ******************* SETCEDSHOW sets the show files wild card string in the Cygnus file requester. ******************* SETCEDDIRCOLOUR n sets the colour for ced directory displays to n. ******************* SETCEDFILECOLOUR' n sets the colour for the file display to n ******************* SETCEDDEVCOLOUR n sets the colour for device display to n ******************* SETCEDLINES nn sets the number of lines in the requester to nn. ******************* SETCEDFILECOLS nn sets the number in the files column to nn. ******************* SETCEDDEVCOLS nn set sets the number in the device column to nn. ******************* SETCEDBOXCOLOUR n sets string requester box colour. ******************* FILEREQUESTER Call the Arp file requester. The full pathname of the selected file will be returned in 'result'. If 'cancel' is selected on the Arp file requester, a null string will be returned in 'result'. ******************* SETARPDIR dirname will set the initial directory string in the Arp file requester to dirname. ******************* SETARPFILE filename will set the initial file string in the Arp file requester to filename. ******************* SETARPTITLE title will set the title in the Arp file requester. ******************* SETARPCOLOUR number will set the colour of the Arp file requester. The number can be 1 or 2. ******************* POPREQUESTER text will put a requester displaying the text on the top screen with a YES/NO choice. The selection is passed back in RESULT as YES or NO. ******************* GETACTIVEWINDOW Gets the active window address and returns it in 'result'. ******************* GETNEXTWINDOW address Get the address of the next window on a screen. The parameter is an address of a window. ******************* GETPOINTERWINDOW Get the address of the window under the pointer. The address is returned in 'result'. ******************* GETSCREEN title Get the screen address from the title. Note that the title is case sensitive. The address is returned in 'result'. ******************* GETTITLEOFSCREEN address Get a screen title from a screen address. The title is returned in 'result'. ******************* GETTOPSCREEN Get the address of the top screen. The address is returned in 'result'. ******************* GETWINDOW title Get the address of the window with this title. The address is returned in 'result'. Note that 'title' is case sensitive; make sure you specify the exact title. The window can be on any screen. ******************* HIDEWINDOW address Hide the window with the specified address. ******************* INJECT CLICK data Injects data into the window where you click the left mouse button. A small window will appear on the top screen asking you to click where you want the data injected. The data to be injected is specified by the second operand. If you precede the data by a hex '01' ('01'x in ARexx), a Right Amiga+x will be inserted to clear a string requester). ******************* INJECT ACTIVE data Injects data into the active window. The data to be injected is specified by the second operand. ******************* INJECT address data Injects data into the window with the the address specified in the first operand. The data is specified by the second operand. ******************* LOADKEYS filename Load new key definitions from the specified file name. ******************* MOVEWINDOW address x-position y-position Move a window to a new position. The first parameter is a window address, the second is the X position and the third is the Y position. If you attempt to move a window outside a screen's limits a return code of 10 will be set. Set the popup status of the clock. ******************* QUALIFIER 'nnnn'x Set a key qualifier for injected data. The qualifier is 2 hex bytes and the values are explained below. This feature is useful if you want to inject, for example, a Right Amiga+Right Shift+Return. The qualifier remains set for all injected data, so you must reset it. A normal key depression has a qualifier of '8000'x (relative mouse). NOTE: this is only effective for data injected with INJECT ACTIVE or INJECT address. It will not work with INJECT CLICK. Qualifiers ---------- IEQUALIFIER_LSHIFT EQU $0001 Left shift IEQUALIFIER_RSHIFT EQU $0002 Right Shift IEQUALIFIER_CAPSLOCK EQU $0004 Caps Lock IEQUALIFIER_CONTROL EQU $0008 CTRL IEQUALIFIER_LALT EQU $0010 Left Alt IEQUALIFIER_RALT EQU $0020 Right Alt IEQUALIFIER_LCOMMAND EQU $0040 Left Amiga IEQUALIFIER_RCOMMAND EQU $0080 Right Amiga IEQUALIFIER_RELATIVEMOUSE EQU $8000 Reset to this value. NB. OR the bits together to set a qualifier: eg: '8022'x is Right shift+Right alt+Relative mouse. You should always include the relative mouse bit. ******************* RETRIEVEWINDOW address Retrieve the hidden window with this address. ******************* SCREENFLIP Push the top screen to the bottom. ******************* SCREENFORWINDOW address Get the address of the screen which contains this window. The parameter is a window address. The address is returned in 'result'. ******************* SCREENTOFRONT address Bring the screen with this address to the front. ******************* WINDOWTOBACK address Push the window with this address to the back. ******************* WINDOWTOFRONT address Bring the window with this address to the front. ******************** CLOSEWINDOW Closes the clock display window. ******************** OPENWINDOW Opens the clock display window. ******************** GETNAMEOFSCREEN address Gets the name of the public screen whose address is specified by "address". Note that the public screen name is not the same as the title. The name is returned in RESULT. *** Needs 2.04 of the OS ****** ******************** SETDEFAULTSCREEN name Sets the named screen as the default screen for opening all windows (instead of the Workbench screen). To reset to workbench, issue the command with a null "name". *** Needs 2.04 of the OS ****** ******************** GETMOUSEX Gets the X position of the mouse in RESULT. ******************** GETMOUSEY Gets the Y position of the mouse in RESULT. ARexx configuration commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ CHIP Change the clock to display chip/fast memory. ******************* TOTAL Change the clock to display total memory. ******************* COLOUR nn Change the colour of the clock display to nn (0-11). Note: nn corresponds to a colour item menu selection ******************* PRIORITY n Sets the clock priority to "n". ******************* REFRESH n Sets the refresh rate to "n". ******************* BLANKSCREEN OFF | n Sets the screen blanker off or to "n". ******************* BLANKPOINTER OFF | n Sets the pointer blanking off or to "n". ******************* KEYBLANK OFF | ON Sets the pointer blanking on hitting a key off or on. ******************* MOUSESPEED n Sets the mouse speed to "n". ******************* CLICKTOFRONT OFF | n Sets the window click to front off or to "n". ******************* DISCARD OFF | ON Sets whether the last mouse click should be discarded after clicking a window to the front. ******************* CLICKTOBACK OFF | n Sets the window click to back off or to "n". ******************* SUN OFF | IMMEDIATE | DELAYED Sets the sun mouse off or to delayed or immediate mode. ******************* CYCLE ON|OFF Sets the screen cycling using the mouse buttons off or on. ******************* KEYACTIVATE OFF | ON Sets Key activate off or on. ******************* MAPKEYS OFF | ON Sets the key mapping feature off or on. ******************* SHOWDATE OFF | ON Sets the date function off or on. ******************* POPUP OFF | WINDOWS | SCREENS Sets the clock window pop-up option. ******************* David Jenkins.